/*
 *
 * Copyright (c) 2006-2020, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.common.codegen.model;

import com.speedment.common.codegen.internal.model.EnumImpl;
import com.speedment.common.codegen.model.modifier.EnumModifier;
import com.speedment.common.codegen.model.trait.HasConstructors;

import java.util.List;

import static java.util.Objects.requireNonNull;

/**
 * A model that represents an enumeration in code.
 *
 * @author Emil Forslund
 * @see EnumConstant
 * @since  2.0
 */
public interface Enum extends ClassOrInterface<Enum>, EnumModifier<Enum>,
    HasConstructors<Enum> {

    /**
     * Adds the specified constant to this enum. The constant must not be null.
     *
     * @param constant the constant
     * @return a reference to this model
     */
    default Enum add(EnumConstant constant) {
        getConstants().add(requireNonNull(constant));
        return this;
    }

    /**
     * Returns a modifiable list of all the constants in this enum.
     *
     * @return a list of constants
     */
    List<EnumConstant> getConstants();

    /**
     * Creates a new instance implementing this interface by using the default
     * implementation.
     *
     * @param name the name
     * @return the new instance
     */
    static Enum of(String name) {
        return new EnumImpl(name);
    }
}